home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / catn / message.n < prev    next >
Text File  |  1994-09-20  |  8KB  |  199 lines
  1.  
  2.  
  3.  
  4. message(n)                 Tk Commands
  5.  
  6.  
  7.  
  8. _________________________________________________________________
  9.  
  10. NAME
  11.      message - Create and manipulate message widgets
  12.  
  13. SYNOPSIS
  14.      message _p_a_t_h_N_a_m_e ?_o_p_t_i_o_n_s?
  15.  
  16. STANDARD OPTIONS
  17.      anchor          cursor         padX            text           |
  18.      background      font           padY            textVariable   |
  19.      borderWidth     foreground     relief          width          |
  20.  
  21.      See the ``options'' manual entry for details on the standard
  22.      options.
  23.  
  24. WIDGET-SPECIFIC OPTIONS
  25.      Name:           aspect
  26.      Class:          Aspect
  27.      Command-Line Switch:-aspect
  28.  
  29.           Specifies  a  non-negative  integer  value   indicating
  30.           desired aspect ratio for the text.  The aspect ratio is
  31.           specified as  100*width/height.   100  means  the  text
  32.           should  be  as  wide  as it is tall, 200 means the text
  33.           should be twice as wide as it is  tall,  50  means  the
  34.           text  should be twice as tall as it is wide, and so on.  |
  35.           Used to choose line length for  text  if  width  option  |
  36.           isn't specified.  Defaults to 150.
  37.  
  38.      Name:           justify
  39.      Class:          Justify
  40.      Command-Line Switch:-justify
  41.  
  42.           Specifies how to justify lines of text.  Must be one of
  43.           left, center, or right.  Defaults to left.  This option  |
  44.           works together with the anchor, aspect, padX, padY, and  |
  45.           width  options  to provide a variety of arrangements of  |
  46.           the text within  the  window.   The  aspect  and  width  |
  47.           options  determine the amount of screen space needed to  |
  48.           display the text.  The anchor, padX, and  padY  options  |
  49.           determine  where  this  rectangular  area  is displayed  |
  50.           within the widget's  window,  and  the  justify  option  |
  51.           determines  how each line is displayed within that rec-  |
  52.           tangular region.  For example, suppose anchor is e  and  |
  53.           justify  is  left,  and that the message window is much  |
  54.           larger than needed for the text.   The  the  text  will  |
  55.           displayed  so that the left edges of all the lines line  |
  56.           up and the right edge of the longest line is padX  from  |
  57.           the  right  side  of the window;  the entire text block  |
  58.           will be centered in the vertical span of the window.
  59.  
  60.  
  61.  
  62.  
  63. Tk                                                              1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. message(n)                 Tk Commands
  71.  
  72.  
  73.  
  74.      Name:           width                                         |
  75.      Class:          Width                                         |
  76.      Command-Line Switch:-width                                    |
  77.  
  78.                                                                         ||
  79.           Specifies the length of lines in the window.  The value  |
  80.           may have any of the forms acceptable  to  Tk_GetPixels.  |
  81.           If  this  option has a value greater than zero then the  |
  82.           aspect option is ignored and the  width  option  deter-  |
  83.           mines the line length.  If this option has a value less  |
  84.           than or equal to zero, then the  aspect  option  deter-  |
  85.           mines the line length.
  86. _________________________________________________________________
  87.  
  88.  
  89. DESCRIPTION
  90.      The message command creates a new window (given by the _p_a_t_h_-
  91.      _N_a_m_e  argument)  and  makes it into a message widget.  Addi-
  92.      tional options, described above, may  be  specified  on  the
  93.      command  line or in the option database to configure aspects
  94.      of the message such as its colors, font, text,  and  initial
  95.      relief.   The message command returns its _p_a_t_h_N_a_m_e argument.
  96.      At the time this command is invoked, there must not exist  a
  97.      window named _p_a_t_h_N_a_m_e, but _p_a_t_h_N_a_m_e's parent must exist.
  98.  
  99.      A message is a widget that displays  a  textual  string.   A
  100.      message widget has three special features.  First, it breaks
  101.      up its string into lines in order to produce a given  aspect
  102.      ratio  for  the  window.  The line breaks are chosen at word
  103.      boundaries wherever possible (if  not  even  a  single  word
  104.      would  fit  on  a  line,  then the word will be split across
  105.      lines).  Newline characters in the string  will  force  line
  106.      breaks;  they can be used, for example, to leave blank lines
  107.      in the display.
  108.  
  109.      The second feature of a  message  widget  is  justification.
  110.      The  text  may be displayed left-justified (each line starts
  111.      at the left side of the window), centered on a  line-by-line
  112.      basis,  or right-justified (each line ends at the right side
  113.      of the window).
  114.  
  115.      The third feature of a message widget  is  that  it  handles
  116.      control  characters  and  non-printing characters specially.
  117.      Tab characters are replaced with enough blank space to  line
  118.      up  on  the  next 8-character boundary.  Newlines cause line
  119.      breaks.  Other control  characters  (ASCII  code  less  than
  120.      0x20)  and  characters not defined in the font are displayed
  121.      as a four-character sequence \x_h_h where _h_h is the  two-digit
  122.      hexadecimal  number  corresponding to the character.  In the
  123.      unusual case where the font doesn't contain all of the char-
  124.      acters in ``0123456789abcdef\x'' then control characters and
  125.      undefined characters are not displayed at all.
  126.  
  127.  
  128.  
  129. Tk                                                              2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. message(n)                 Tk Commands
  137.  
  138.  
  139.  
  140. WIDGET COMMAND
  141.      The message command creates a new Tcl command whose name  is
  142.      _p_a_t_h_N_a_m_e.  This command may be used to invoke various opera-
  143.      tions on the widget.  It has the following general form:
  144.  
  145.           _p_a_t_h_N_a_m_e _o_p_t_i_o_n ?_a_r_g _a_r_g ...?
  146.  
  147.      _O_p_t_i_o_n and the _a_r_gs determine the exact behavior of the com-
  148.      mand.  The following commands are possible for message widg-
  149.      ets:
  150.  
  151.      _p_a_t_h_N_a_m_e configure ?_o_p_t_i_o_n? ?_v_a_l_u_e _o_p_t_i_o_n _v_a_l_u_e ...?
  152.           Query  or  modify  the  configuration  options  of  the
  153.           widget.   If  no  _o_p_t_i_o_n  is  specified, returns a list
  154.           describing all of the available  options  for  _p_a_t_h_N_a_m_e
  155.           (see  Tk_ConfigureInfo for information on the format of
  156.           this list).  If _o_p_t_i_o_n is specified with no _v_a_l_u_e, then
  157.           the  command  returns  a  list describing the one named
  158.           option (this list will be identical to the  correspond-
  159.           ing  sublist  of  the  value  returned  if no _o_p_t_i_o_n is
  160.           specified).  If one  or  more  _o_p_t_i_o_n-_v_a_l_u_e  pairs  are
  161.           specified,  then  the command modifies the given widget
  162.           option(s) to have the given value(s);  in this case the
  163.           command  returns  an empty string.  _O_p_t_i_o_n may have any
  164.           of the values accepted by the message command.
  165.  
  166.  
  167. DEFAULT BINDINGS
  168.      When a new message is created, it has no default event bind-
  169.      ings: messages are intended for output purposes only.
  170.  
  171.  
  172. BUGS
  173.      Tabs don't work very well with  text  that  is  centered  or
  174.      right-justified.  The most common result is that the line is
  175.      justified wrong.
  176.  
  177.  
  178. KEYWORDS
  179.      message, widget
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195. Tk                                                              3
  196.  
  197.  
  198.  
  199.